Skip to main content

getAnimationID

Type​

function

Summary​

Returns the ID of any active animation for a specific control and property.

Syntax​

get getAnimationID(pControl, pPropertyName)

Description​

Use getAnimationID to find if a specific property of a control is currently being animated. Returns the animation ID that can be used with other animation commands like stopAnimation or pauseAnimation.

Parameters​

NameTypeDescription

pControl

The long id of the control

pPropertyName

Name of the property being animated

Examples​

local tID
put getAnimationID(the long id of button "Test", "left") into tID
if tID is not empty then
stopAnimation tID
end if

Value​

NameTypeDescription

return

String containing the animation ID if found, empty if no animation exists.

Compatibility and Support​

OS

mac

windows

linux

ios

android

Platforms

desktop

mobile

web